Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix logic clear status and save status #34780

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Jan 19, 2024

Details

Fixed Issues

$ #33735
PROPOSAL: #33735 (comment)

Tests

  1. Log in with any account.
  2. Open Settings/ Profile/ Status
  3. Verify that it shows a disabled emoji icon and select a any emoji
  4. Verify that status emoji appears
  5. Clear status and verify that status emoji cleared
  6. Press Save button
  7. Cleared status is not visible if press save button
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Log in with any account.
  2. Open Settings/ Profile/ Status
  3. Verify that it shows a disabled emoji icon and select a any emoji
  4. Verify that status emoji appears
  5. Clear status and verify that status emoji cleared
  6. Press Save button
  7. Cleared status is not visible if press save button
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
android.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
desktop-resize.mp4

@dukenv0307 dukenv0307 changed the title fixlogic clear status and save status fix logic clear status and save status Jan 19, 2024
@dukenv0307 dukenv0307 marked this pull request as ready for review January 22, 2024 03:49
@dukenv0307 dukenv0307 requested a review from a team as a code owner January 22, 2024 03:49
@melvin-bot melvin-bot bot requested review from Ollyws and removed request for a team January 22, 2024 03:49
Copy link

melvin-bot bot commented Jan 22, 2024

@Ollyws Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@Ollyws
Copy link
Contributor

Ollyws commented Jan 22, 2024

Thanks for the PR, it generally looks good.
One thing I think it a little incongruent is that if the user has the placeholder emoji selected and the status is empty it will set the default speech bubble emoji, maybe in that case it would make more sense to set the status as completely cleared?

StatusExample.mov

It would be great if @Expensify/design could give us an opinion on that.

Also there is a brief period where after the user has cleared their status they can click the save button before we navigate away, which will set the speech bubble emoji as the status.

@shawnborton
Copy link
Contributor

One thing I think it a little incongruent is that if the user has the placeholder emoji selected and the status is empty it will set the default speech bubble emoji

My understanding is that this is a known bug and is being fixed? cc @amyevans for thoughts there

@amyevans
Copy link
Contributor

My understanding is that this is a known bug and is being fixed? cc @amyevans for thoughts there

🤔 Do you know where it is being fixed? IMO once the message becomes empty, we should remove the default speech bubble emoji and display the placeholder emoji (And handle that in this PR if we don't have a distinct GH for it elsewhere.)

@shawnborton
Copy link
Contributor

Ah, I thought you commented in Slack that it would be fixed here: #34780

But now I am realizing... here is this PR 🤣

So yeah, let's fix that behavior here.

@amyevans
Copy link
Contributor

Lol okay I thought that might've been the source of the confusion but wasn't sure 😄

@Ollyws
Copy link
Contributor

Ollyws commented Jan 23, 2024

So to clarify:

  • When the message is empty, the emoji should be cleared and the placeholder should be shown.

  • If the save button is pressed when the message is empty then the status should be completely cleared (the same as if we had pressed the clear button)

Please let me know if I'm missing anything.

@shawnborton
Copy link
Contributor

That sounds correct to me.

@shawnborton
Copy link
Contributor

Although, I wonder if we should allow a user to save a status that is just the emoji and no message?

If they save a message that doesn't have an emoji, perhaps we just default to a comment bubble or we throw a form error?

@amyevans
Copy link
Contributor

Although, I wonder if we should allow a user to save a status that is just the emoji and no message?

Yeah I think we should definitely allow for this.

If they save a message that doesn't have an emoji, perhaps we just default to a comment bubble or we throw a form error?

I think defaulting to a comment bubble is good (which is what we're already doing)

So the allowable options would be:

  • custom emoji + message
  • custom emoji + no message
  • message only -> comment bubble emoji forced
  • placeholder emoji + no message = status cleared

@shawnborton
Copy link
Contributor

Cool cool, works for me!

@dannymcclain
Copy link
Contributor

Yeah that sounds good to me too 🚀

@dukenv0307
Copy link
Contributor Author

So the allowable options would be:

  • custom emoji + message
  • custom emoji + no message
  • message only -> comment bubble emoji forced
  • placeholder emoji + no message = status cleared

I just updated code to follow this options. @Ollyws please check again

web-resize.mp4

@Ollyws
Copy link
Contributor

Ollyws commented Jan 25, 2024

@amyevans Can I just clarify what you meant by:

IMO once the message becomes empty, we should remove the default speech bubble emoji and display the placeholder emoji

Did you mean that if the user deletes their status (by pressing backspace for example) when the text input is empty the status emoji should revert to the placeholder?

@amyevans
Copy link
Contributor

Did you mean that if the user deletes their status (by pressing backspace for example) when the text input is empty the status emoji should revert to the placeholder?

Yes, that's what I was envisioning. However I'll let @Expensify/design weigh in again too!

@dannymcclain
Copy link
Contributor

I don't have super strong feelings about that—could honestly go either way. I am liking what I'm seeing in this video though! It's comin' along!

@shawnborton
Copy link
Contributor

Hmm not entirely sure what my opinion is there. I think if there happens to be an emoji present in the emoji selector, the user should have to press clear status or pick a different emoji. I don't think I would expect that clearing the text input would change the emoji, mostly because we are supporting that users could have an emoji-only status right?

@dannymcclain
Copy link
Contributor

I think if there happens to be an emoji present in the emoji selector, the user should have to press clear status or pick a different emoji. I don't think I would expect that clearing the text input would change the emoji

You know what, now that you lay it out like this, I'm more in favor of making the user press clear or select a different emoji. So NOT resetting the emoji if they delete the message. That's my vote.

@amyevans
Copy link
Contributor

Right, yes, I should have clarified I would expect it to be cleared only if it was the comment bubble emoji.

@dannymcclain
Copy link
Contributor

Right, yes, I should have clarified I would expect it to be cleared only if it was the comment bubble emoji.

Even so, I think if you want to clear it you should click the explicit Clear status button. :my2cents:

@amyevans
Copy link
Contributor

That's fair, and I definitely don't feel passionately about it. I'm happy to move forward with the functionality as-is in the PR!

@Ollyws
Copy link
Contributor

Ollyws commented Jan 29, 2024

Thanks for the discussion! Seems like the PR has everything covered.

@amyevans
Copy link
Contributor

Yep let's proceed with code review!

@Ollyws
Copy link
Contributor

Ollyws commented Jan 29, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
01_Android_Native.mp4
Android: mWeb Chrome
02_Android_Chrome.mp4
iOS: Native
03_iOS_Native.mp4
iOS: mWeb Safari
04_iOS_Safari.mp4
MacOS: Chrome / Safari
05_MacOS_Chrome.mp4
MacOS: Desktop
06_MacOS_Desktop.mp4

Copy link
Contributor

@Ollyws Ollyws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@melvin-bot melvin-bot bot requested a review from amyevans January 29, 2024 17:09
@amyevans amyevans merged commit c35e963 into Expensify:main Jan 29, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.33-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 cancelled 🔪
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants